A partner can be a client or a vendor, currently we only use them for clients.
name | value |
---|---|
partnerNumber | P-31010 |
personType | LEGAL_PERSON |
tradeName | Test AG |
contactCaption | Test AG - Hamburg |
postalAddress | “firm”: “Test AG”, “street”: “Shanghai-Allee 1”, “zipcode”: “20123”, “city”: “Hamburg”, “country”: “Germany” |
officePhoneNumber | +49 40 654321-0 |
emailAddress | hamburg@test-ag.example.org |
registrationOffice | Registergericht Hamburg |
registrationNumber | 1234567 |
GET /api/hs/office/persons?name=Hostsharing+eG
=> status: 200 OK
[ {
"uuid" : "c6575205-1480-4b70-a30b-d0c5a1d7cc99", // Person: Hostsharing eG
"personType" : "LEGAL_PERSON",
"tradeName" : "Hostsharing eG",
"salutation" : null,
"title" : null,
"givenName" : null,
"familyName" : null
} ]
Even in production data we expect this query to return just a single result.
POST /api/hs/office/persons
{
"personType" : "LEGAL_PERSON",
"tradeName" : "Test AG"
}
=> status: 201 CREATED f8f6ad7e-53d2-4cf0-9cb9-30ca2767c599
POST /api/hs/office/contacts
{
"caption" : "Test AG - Hamburg",
"postalAddress" : {
"firm" : "Test AG",
"street" : "Shanghai-Allee 1",
"zipcode" : "20123",
"city" : "Hamburg",
"country" : "Germany"
},
"phoneNumbers" : {
"office" : "+49 40 654321-0"
},
"emailAddresses" : {
"main" : "hamburg@test-ag.example.org"
}
}
=> status: 201 CREATED e4866b08-4914-4409-9abe-ca187634729d
POST /api/hs/office/partners
{
"partnerNumber" : "P-31010",
"partnerRel" : {
"anchor.uuid" : "c6575205-1480-4b70-a30b-d0c5a1d7cc99", // Person: Hostsharing eG
"holder.uuid" : "f8f6ad7e-53d2-4cf0-9cb9-30ca2767c599", // Person: Test AG
"contact.uuid" : "e4866b08-4914-4409-9abe-ca187634729d" // Contact: Test AG - Hamburg
},
"details" : {
"registrationOffice" : "Registergericht Hamburg",
"registrationNumber" : "1234567"
}
}
=> status: 201 CREATED 72eb4871-122a-42d8-b9a7-e45b7faf9fef
GET /api/hs/office/relations?relationType=PARTNER&contactData=Test+AG+-+Hamburg
=> status: 200 OK
[ {
"uuid" : "a4914399-27dc-4094-bf76-d6230d4f8373",
"anchor" : {
"uuid" : "c6575205-1480-4b70-a30b-d0c5a1d7cc99", // Person: Hostsharing eG
"personType" : "LEGAL_PERSON",
"tradeName" : "Hostsharing eG",
"salutation" : null,
"title" : null,
"givenName" : null,
"familyName" : null
},
"holder" : {
"uuid" : "f8f6ad7e-53d2-4cf0-9cb9-30ca2767c599", // Person: Test AG
"personType" : "LEGAL_PERSON",
"tradeName" : "Test AG",
"salutation" : null,
"title" : null,
"givenName" : null,
"familyName" : null
},
"type" : "PARTNER",
"mark" : null,
"contact" : {
"uuid" : "e4866b08-4914-4409-9abe-ca187634729d", // Contact: Test AG - Hamburg
"caption" : "Test AG - Hamburg",
"postalAddress" : {
"city" : "Hamburg",
"firm" : "Test AG",
"street" : "Shanghai-Allee 1",
"country" : "Germany",
"zipcode" : "20123"
},
"emailAddresses" : {
"main" : "hamburg@test-ag.example.org"
},
"phoneNumbers" : {
"office" : "+49 40 654321-0"
}
}
} ]
generated on 03-10-2025 12:07:38 for branch master